<?php
/**
 * Magento
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.txt.
 * It is also available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@magentocommerce.com so we can send you a copy immediately.
 *
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade Magento to newer
 * versions in the future. If you wish to customize Magento for your
 * needs please refer to http://www.magentocommerce.com for more information.
 *
 * @copyright   Copyright (c) 2014 X.commerce, Inc. (http://www.magentocommerce.com)
 * @license     http://opensource.org/licenses/osl-3.0.php  Open Software License (OSL 3.0)
 */
namespace Magento\CatalogInventory\Service\V1;

use Magento\CatalogInventory\Model\Stock;

/**
 * Interface StockStatusServiceInterface
 */
interface StockStatusServiceInterface
{
    /**
     * Retrieve Product Stock Status
     *
     * @param int $productId
     * @param int $websiteId
     * @param int $stockId
     * @return array
     */
    public function getProductStockStatus($productId, $websiteId, $stockId = Stock::DEFAULT_STOCK_ID);

    /**
     * @param string $sku
     * @return \Magento\CatalogInventory\Service\V1\Data\StockStatus
     * @throw \Magento\Framework\Exception\NoSuchEntityException
     */
    public function getProductStockStatusBySku($sku);

    /**
     * Retrieves a list of SKU's with low inventory qty
     *
     * @param \Magento\CatalogInventory\Service\V1\Data\LowStockCriteria $lowStockCriteria
     * @return \Magento\CatalogInventory\Service\V1\Data\LowStockResult contains string[]
     */
    public function getLowStockItems($lowStockCriteria);
}
